UisCommand Action Type

The UIS Command (UisCommand) action type is used to send a UIS Command to a configured device.

To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.

Example

<Actions>

<Action type="UisCommand" command="SETMSVPOS" relativeFacilityLink="Separator" statusUDC="SYCMDSTAT">

<Parameters>

<Parameter>

<Part type="Text" value="MSVPos" />

<Part type="Text" value="=2" />

</Parameter>

</Parameters>

</Action>

 

<Action type="Test" timeoutValue="TMWTTGT" timeoutValueType="UDC" timeoutValueUpdate="True" timeoutRelativeFacilityLink="" timeoutActualUdc="TMWTACT" udc="POMSV" operator="=" value="1000" conditionRelativeFacilityLink="Separator" sleeptime="5000">

<SleepTimerActions>

<Action type="UisCommand" command="POLL" relativeFacilityLink="Separator" statusUDC="SYCMDSTAT">

<Parameters />

</Action>

</SleepTimerActions>

</Action>

 

</Actions>

UisCommand Action Type Attributes

The UisCommand action type has the following associated configuration attributes:

Attribute Required Description

command

Yes

Specifies the name of the UIS command to execute, E.g., POLL, SETMSVPOS1, SETMSVPOS2, SETMSVPOS3, SETMSVPOS4, START, etc.

relativeFacilityLink

No

Specifies the relative facility tag to use for the action. E.g., Separator

Note:
The facility tag used as the starting point for the relative resolution depends on where this action type is configured. If the action is defined at a position level, then the base facility tag will be the well facility. If defined at the header level, the base facility will be the header facility.

E.g., Separator

statusUDC

Yes

 Specifies the name of the status UDC (if configured) where the status of the UIS Command will be posted. E.g., SYCMDSTAT. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.

type

Yes

Specifies the action type for the action.

E.g. type="UisCommand"

Parameters, Parameter, Part

The UisCommand action type can contain optional <Parameters> elements. These are used to pass in any parameters to the UIS Command. A <Parameters> element has defined <Parameter> elements, each containing one or more <Part> elements. Parts are used to build strings that are used to further configure the action.

Parameters, Parameter, and Part elements can also be used with the Script action type.

Part Type Attributes

<Parameters>

<Parameter>

<Part type="Text" value="OIL=" />

<Part type="PointValue" udc="ROIL" relativeFacilityLink="Separator" attribute="" />

</Parameter>

<Parameter>

<Part type="Text" value="WATER=" />

<Part type="PointValue" udc="RH2O" relativeFacilityLink="Separator" attribute="" />

</Parameter>

<Parameter>

<Part type="Text" value="GAS=" />

<Part type="PointValue" udc="RGAS" relativeFacilityLink="Separator" attribute="" />

</Parameter>

<Parameter>

<Part type="Text" value="DURATION=" />

<Part type="PointValue" udc="TMWTACT" relativeFacilityLink="" attribute="" />

</Parameter>

<Parameter>

<Part type="Text" value="FACILITYTAG=" />

<Part type="FacilityAttribute" relativeFacilityLink="" attribute="FacilityTag" />

</Parameter>

<Parameter>

<Part type="Text" value="TIMESTAMP=" />

<Part type="PointAttribute" udc="TMWTACT" relativeFacilityLink="" attribute="Timestamp" />

</Parameter>

</Parameters>

There are four types of <Part> elements, with the following associated configuration attributes:

Text Part Type
Attribute Required Description

type

Yes

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

value

Yes

Specifies the value to be used for the text part type.
PointValue Part Type
Attribute Required Description

type

Yes

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

attribute

Yes

Specifies a value, a point attribute, or a facility attribute. The available values to use for this field can be found in the CygNet.API Help file under the CygNet.Data.Core > CygNetCoreProperties.CygNetProperty Enumeration section.

relativeFacilityLink

No

Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.

udc

Yes

Specifies the UDC to use to obtain the value for this point, point attribute, or facility attribute. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.
PointAttribute Part Type
Attribute Required Description

type

Yes

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

attribute

Yes

Specifies a value, a point attribute, or a facility attribute. The available values to use for this field can be found in the CygNet.API Help file under the CygNet.Data.Core > CygNetCoreProperties.CygNetProperty Enumeration section.

relativeFacilityLink

No

Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.

udc

Yes

Specifies the UDC to use to obtain the value for this point, point attribute, or facility attribute. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.
FacilityAttribute Part Type
Attribute Required Description

type

Yes

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

attribute

Yes

Specifies a value, a point attribute, or a facility attribute. The available values to use for this field can be found in the CygNet.API Help file under the CygNet.Data.Core > CygNetCoreProperties.CygNetProperty Enumeration section.

relativeFacilityLink

No

Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.

udc

Yes

Specifies the UDC to use to obtain the value for this point, point attribute, or facility attribute. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.

Back to top